﻿//-----------------------------------------------------------------------
// <copyright file="EntityFactoryModule.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace App.Modules.EntityFactory
{
    using System;
    using App.Exceptions;
    using App.Modules.Component;
    using TileTool.Log;
    using TileTool.Scene.Entity;
    using TileTool.Scene.Entity.Group;

    /// <summary>
    /// Module which handles creating entities.
    /// </summary>
    public class EntityFactoryModule : Module
    {
        #region Constants - Private

        /// <summary>
        /// Log message group.
        /// </summary>
        private const string LogGroup = "EntityFactoryModule";

        #endregion

        #region Methods - Public

        /// <summary>
        /// Called when the application is starting up.
        /// </summary>
        public override void Startup()
        {
            LogSystem.LogStartup(LogGroup, "Starting...");

            base.Startup();
        }

        /// <summary>
        /// Called when the application is shutting down.
        /// </summary>
        public override void Shutdown()
        {
            base.Shutdown();
        }

        /// <summary>
        /// Create an entity from the passed component name.
        /// 
        /// Will return null if we fail to create the entity.
        /// </summary>
        /// <param name="componentName">Entity factory component name.</param>
        /// <param name="createData">Entity creation data.</param>
        /// <returns>Returns the new entity or null if it failed to be created.</returns>
        public IEntity CreateEntity(string componentName, EntityCreateData createData)
        {
            if (string.IsNullOrEmpty(componentName))
            {
                throw new ArgumentNullException("componentName", "Component name must not be null.");
            }

            if (createData == null)
            {
                throw new ArgumentNullException("createData", "Create data must be non-null.");
            }

            // $TODO - This is a bit meh. Just make a component for this?
            if (componentName == GroupEntity.ComponentName)
            {
                return new GroupEntity(createData);
            }

            ComponentModule componentModule = GetModule<ComponentModule>();

            try
            {
                EntityFactoryComponentBase factory = componentModule.Get<EntityFactoryComponentBase>(componentName);

                createData.Bag.CreateValue<string>(EntityDataBagKeys.ComponentName, componentName);

                return factory.Allocate(createData);
            }
            catch (AppException e)
            {
                LogSystem.LogError(LogGroup, "Failed to create entity: " + e.ToString());
            }

            return null;
        }

        #endregion
    }
}
